home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / librw / RWHashTableIterator.z / RWHashTableIterator
Encoding:
Text File  |  2002-10-03  |  4.8 KB  |  133 lines
  1.  
  2.  
  3.  
  4. RRRRWWWWHHHHaaaasssshhhhTTTTaaaabbbblllleeeeIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))                            RRRRWWWWHHHHaaaasssshhhhTTTTaaaabbbblllleeeeIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))
  5.  
  6.  
  7.  
  8. NNNNaaaammmmeeee
  9.      RWHashTableIterator - Rogue Wave library class
  10.  
  11. SSSSyyyynnnnooooppppssssiiiissss
  12.               #include <rw/hashtab.h>
  13.  
  14.  
  15.  
  16.               RWHashTable h;
  17.           RWHashTableIterator it(h);
  18.  
  19.  
  20.  
  21.  
  22. DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
  23.      Iterator for class RRRRWWWWHHHHaaaasssshhhhTTTTaaaabbbblllleeee, which allows sequential access to all the
  24.      elements of RRRRWWWWHHHHaaaasssshhhhTTTTaaaabbbblllleeee.  Note that because an RRRRWWWWHHHHaaaasssshhhhTTTTaaaabbbblllleeee is unordered,
  25.      elements are not accessed in any particular order. As with all Rogue Wave
  26.      iterators, the "current item" is undefined immediately after construction
  27.      -- you must define it by using ooooppppeeeerrrraaaattttoooorrrr(((()))) or some other (valid)
  28.      operation.  Once the iterator has advanced beyond the end of the
  29.      collection it is no longer valid -- continuing to use it will bring
  30.      undefined results.
  31.  
  32. PPPPeeeerrrrssssiiiisssstttteeeennnncccceeee
  33.      None
  34.  
  35. PPPPuuuubbbblllliiiicccc CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  36.               RRRRWWWWHHHHaaaasssshhhhTTTTaaaabbbblllleeeeIIIItttteeeerrrraaaattttoooorrrr(RWHashTable&);
  37.  
  38.  
  39.      Construct an iterator for an RRRRWWWWHHHHaaaasssshhhhTTTTaaaabbbblllleeee.  After construction, the
  40.      position of the iterator is undefined.
  41.  
  42. PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr OOOOppppeeeerrrraaaattttoooorrrr
  43.               virtual RWCollectable*
  44.           ooooppppeeeerrrraaaattttoooorrrr(((())))();
  45.  
  46.  
  47.      Redefined from class RRRRWWWWIIIItttteeeerrrraaaattttoooorrrr.  Advances the iterator to the next item
  48.      and returns it. Returns nnnniiiillll when the end of the collection is reached.
  49.  
  50. PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss
  51.               virtual RWCollectable*
  52.           ffffiiiinnnnddddNNNNeeeexxxxtttt(const RWCollectable* target);
  53.  
  54.  
  55.      Redefined from class RRRRWWWWIIIItttteeeerrrraaaattttoooorrrr.  Moves iterator to the next item which
  56.      iiiissssEEEEqqqquuuuaaaallll ttttoooo the item pointed to by ttttaaaarrrrggggeeeetttt and returns it.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. RRRRWWWWHHHHaaaasssshhhhTTTTaaaabbbblllleeeeIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))                            RRRRWWWWHHHHaaaasssshhhhTTTTaaaabbbblllleeeeIIIItttteeeerrrraaaattttoooorrrr((((3333CCCC++++++++))))
  71.  
  72.  
  73.  
  74.               virtual RWCollectable*
  75.           kkkkeeeeyyyy() const;
  76.  
  77.  
  78.      Redefined from class RRRRWWWWIIIItttteeeerrrraaaattttoooorrrr.  Returns the item at the current
  79.      iterator position.
  80.  
  81.               RWCollectable*
  82.           rrrreeeemmmmoooovvvveeee();
  83.  
  84.  
  85.      Remove the item at the current iterator position from the collection.
  86.  
  87.               RWCollectable*
  88.           rrrreeeemmmmoooovvvveeeeNNNNeeeexxxxtttt(const RWCollectable*);
  89.  
  90.  
  91.      Moves the iterator to the next item which iiiissssEEEEqqqquuuuaaaallll to the item pointed to
  92.      by ttttaaaarrrrggggeeeetttt, removes it from the collection and returns it.  If no item is
  93.      found, returns nnnniiiillll and the position of the iterator will be undefined.
  94.  
  95.               virtual void
  96.           rrrreeeesssseeeetttt();
  97.  
  98.  
  99.      Redefined from class RRRRWWWWIIIItttteeeerrrraaaattttoooorrrr.  Resets the iterator to its starting
  100.      state.
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.